Skip to content

Add readme, license, authors, and URLs to project metadata#6

Merged
alexdej merged 2 commits intomainfrom
fix-pypi-metadata
Mar 26, 2026
Merged

Add readme, license, authors, and URLs to project metadata#6
alexdej merged 2 commits intomainfrom
fix-pypi-metadata

Conversation

@alexdej
Copy link
Copy Markdown
Owner

@alexdej alexdej commented Mar 26, 2026

No description provided.

Copilot AI review requested due to automatic review settings March 26, 2026 20:21
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the project’s packaging metadata to include richer, publish-friendly information (README, license, authors, and URLs) and adds an MIT LICENSE file.

Changes:

  • Add readme, license, and authors fields to [project] metadata.
  • Add [project.urls] for Homepage/Repository links.
  • Add an MIT LICENSE file to the repository.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
pyproject.toml Adds project metadata fields (README/license/authors) and project URLs for packaging/publishing.
LICENSE Introduces MIT license text for the project.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread pyproject.toml
Comment on lines +9 to +13
readme = "README.md"
license = "MIT"
authors = [
{ name = "Alex DeJarnatt", email = "adejarnatt@gmail.com" },
]
Copy link

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

license = "MIT" follows the newer PEP 639 approach (SPDX license expression), but it may not be understood by older setuptools releases. Since [build-system].requires currently allows setuptools>=64, consider either (a) bumping the minimum setuptools version to one that supports PEP 639 license metadata, or (b) switching to the legacy PEP 621 table form for license. Also consider adding license-files = ["LICENSE"] so the LICENSE file is included in built distributions.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot apply changes based on this feedback

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Switched to the PEP 621 table form license = {file = "LICENSE"} in commit 4471a96. This is compatible with setuptools>=64 and also ensures the LICENSE file is included in built distributions.

@alexdej alexdej merged commit a19ffc2 into main Mar 26, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants